
/*
 * Copyright 2002-2022 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
/*
 *版权所有2002-2022原作者。
 *
 *根据Apache许可证2.0版许可（“许可证”）；
 *除非符合许可证的规定，否则您不得使用此文件。
 *您可以在以下网址获取许可证副本：
 *
 *https://www.apache.org/licenses/LICENSE-2.0
 *
 *除非适用法律要求或书面同意，软件
 *根据许可证进行的分发是在“按原样”的基础上进行的，
 *无任何明示或暗示的保证或条件。
 *有关管理权限的特定语言，请参阅许可证和
 *许可证下的限制。
 */

package org.springframework.ui;

import java.util.Collection;
import java.util.Map;

import org.springframework.lang.Nullable;

/**
 * Interface that defines a holder for model attributes.
 *
 * <p>Primarily designed for adding attributes to the model.
 *
 * <p>Allows for accessing the overall model as a {@code java.util.Map}.
 *
 * @author Juergen Hoeller
 * @since 2.5.1
 */
/**
 *接口，用于定义模型属性的持有者。
 *
 *<p>主要设计用于向模型添加属性。
 *
 *＜p＞允许以｛@code java.util.Map｝的形式访问整个模型。
 *
 *@作者于尔根·霍勒
 *@自2.5.1起
 */
public interface Model {

	/**
	 * Add the supplied attribute under the supplied name.
	 * @param attributeName the name of the model attribute (never {@code null})
	 * @param attributeValue the model attribute value (can be {@code null})
	 */
	/**
	 *在提供的名称下添加提供的属性。
	 *@param attributeName模型属性的名称（从不｛@code null｝）
	 *@param attributeValue模型属性值（可以是｛@code null｝）
	 */
	Model addAttribute(String attributeName, @Nullable Object attributeValue);

	/**
	 * Add the supplied attribute to this {@code Map} using a
	 * {@link org.springframework.core.Conventions#getVariableName generated name}.
	 * <p><i>Note: Empty {@link java.util.Collection Collections} are not added to
	 * the model when using this method because we cannot correctly determine
	 * the true convention name. View code should check for {@code null} rather
	 * than for empty collections as is already done by JSTL tags.</i>
	 * @param attributeValue the model attribute value (never {@code null})
	 */
	/**
	 *使用
	 *｛@link org.springframework.core.Conferences#getVariableName生成的名称｝。
	 *＜p＞＜i＞注意：空的｛@link java.util.Collection Collections｝不会添加到
	 *使用此方法时的模型，因为我们无法正确确定
	 *真正的约定名称。视图代码应该检查｛@code null｝，而不是
	 *而不是空集合，正如JSTL标记已经完成的那样</我>
	 *@param attributeValue模型属性值（从不｛@code null｝）
	 */
	Model addAttribute(Object attributeValue);

	/**
	 * Copy all attributes in the supplied {@code Collection} into this
	 * {@code Map}, using attribute name generation for each element.
	 * @see #addAttribute(Object)
	 */
	/**
	 *将提供的｛@code Collection｝中的所有属性复制到此
	 *｛@code Map｝，对每个元素使用属性名称生成。
	 *@参见#addAttribute（对象）
	 */
	Model addAllAttributes(Collection<?> attributeValues);

	/**
	 * Copy all attributes in the supplied {@code Map} into this {@code Map}.
	 * @see #addAttribute(String, Object)
	 */
	/**
	 *将提供的｛@code Map｝中的所有属性复制到此｛@code-Map｝中。
	 *@see#addAttribute（字符串，对象）
	 */
	Model addAllAttributes(Map<String, ?> attributes);

	/**
	 * Copy all attributes in the supplied {@code Map} into this {@code Map},
	 * with existing objects of the same name taking precedence (i.e. not getting
	 * replaced).
	 */
	/**
	 *将提供的｛@code Map｝中的所有属性复制到此｛@code-Map｝中，
	 *具有相同名称的现有对象优先（即不获取
	 *已更换）。
	 */
	Model mergeAttributes(Map<String, ?> attributes);

	/**
	 * Does this model contain an attribute of the given name?
	 * @param attributeName the name of the model attribute (never {@code null})
	 * @return whether this model contains a corresponding attribute
	 */
	/**
	 *这个模型是否包含给定名称的属性？
	 *@param attributeName模型属性的名称（从不｛@code null｝）
	 *@return此模型是否包含相应的属性
	 */
	boolean containsAttribute(String attributeName);

	/**
	 * Return the attribute value for the given name, if any.
	 * @param attributeName the name of the model attribute (never {@code null})
	 * @return the corresponding attribute value, or {@code null} if none
	 * @since 5.2
	 */
	/**
	 *返回给定名称的属性值（如果有的话）。
	 *@param attributeName模型属性的名称（从不｛@code null｝）
	 *@返回相应的属性值，或者｛@code null｝如果没有
	 *@自5.2起
	 */
	@Nullable
	Object getAttribute(String attributeName);

	/**
	 * Return the current set of model attributes as a Map.
	 */
	/**
	 *将当前模型属性集作为Map返回。
	 */
	Map<String, Object> asMap();

}
